home *** CD-ROM | disk | FTP | other *** search
/ PC Gamer (Italian) 29 / PC Gamer IT CD 29 2-2.iso / ES3ATR2 / ES3ATR2.exe / _user1.cab / USERSETUP_LANGINDOSIND / input.txt < prev    next >
Text File  |  1998-02-22  |  11KB  |  271 lines
  1. ----------------------------------------------------------------------------------------------------
  2.                 INPUT MAPPING HELP TEXT
  3. ----------------------------------------------------------------------------------------------------
  4.  
  5. The purpose of this document is explain how to use StarSiege's input mapping utility.
  6. It will allow complete control over how you control your HERC.
  7.  
  8.     SECTIONS:
  9.     
  10.     1. CREATING A CUSTOM KEYMAPPING
  11.     2. USING MAKES AND BREAKS
  12.     3. USING PARAMETERS
  13.     4. LOADING A CUSTOM KEYMAPPING
  14.     5. INPUT
  15.     6. ACTION DEFINITIONS
  16.     7. EXAMPLES
  17.  
  18.  
  19.  
  20. 1. CREATING A CUSTOM KEYMAPPING
  21. -------------------------------
  22.  
  23. First, open any *.cs file located in the install directory (usually c:\games\Es3Alpha\Keymaps) 
  24. Notice that it is divided into 3 different sections ( Camera, CameraOrbit,and Herc ). 
  25. The different sections indicate the control scheme for different control modes.  For example, 
  26. when piloting a HERC, the Herc control section will be used, or when in an external camera view, 
  27. the CameraOrbit control section will be used.
  28.  
  29. The Keymapping files can be nested, or "included" within each other. In the Joystick.cs file,
  30. the following lines indicate other keymap files that are combined with the joystick.cs
  31. file to create a complete keymap for multiple input devices and functions:
  32.  
  33. #------------------------------------------------------------------------------
  34. # include generic camera controls
  35. exec _defCamera.cs
  36.  
  37.  
  38. #------------------------------------------------------------------------------
  39. # include generic keyboard controls
  40. exec _defKeyboard.cs
  41.  
  42.  
  43. This is done mainly for convenience. If you wish to create a single file that contains 
  44. "everything" you can do so.
  45.  
  46.  
  47. 2. USING MAKES AND BREAKS 
  48. -------------------------------
  49.  
  50. It is crucial to use the "make" and "break" keywords correctly.  When binding input to actions such as
  51. firing, moving, or looking ( actions that should generally occur only when holding down a key or button ), 
  52. use the "make" to initiate the action, and "break" to turn it off.
  53. Example:
  54.  
  55. "bindAction keyboard make space TO ACTION_FIRE 1.0"
  56. "bindAction kyboard break space TO ACTION_FIRE 0.0"
  57.  
  58. The value at the end represents a toggle, where 1.0 is on and 0.0 is off.
  59.  
  60.  
  61. 3.  USING PARAMETERS 
  62. --------------------------------
  63.  
  64. Most actions require a value at the end of a binding statement ( see ACTION DEFINITIONS below for more info ). 
  65. There are five additional parameters that you have the option of using.  They are: 
  66.  
  67. flip:        Reverses the coordinate system for the chosen action (ACTION_YAW -1.0 would turn left instead of right)
  68.         Example : "bindAction joystick yaxis TO ACTION_LOOK_Y flip" 
  69.  
  70. deadzone:    Kills all input that lies within the specified range.
  71.         (e.g.,If you enter 'deadzone 0.1', the deadzone will be 10% of your total axis ).
  72.         Example: "bindAction joystick xaxis TO ACTION_YAW deadzone 0.1" 
  73.  
  74. center:        Centers your the coordinate system of your control device from (0.0, 1.0) to (-1.0,1.0)
  75.         Example: "bindAction joystick yaxis TO ACTION_SPEED center"        
  76.  
  77. square:        Changes the growth rate of constant input (e.g., pulling down on a joystick)from linear to parabolic.
  78.         Example: "bindAction joystick yaxis TO ACTION_SPEED square"
  79.  
  80. scale:        Scales the sensitivity of an input signal, based on the value you give it.  
  81.         Example:"bindAction joystick zaxis TO ACTION_SPEED scale 0.2
  82.  
  83. Note that it is possible to string five of these parameters onto the end of one action.  For example,
  84. you could enter a line that looked like this: 
  85.  
  86. "bindAction joystick yaxis TO ACTION_SPEED deadzone 0.2 center square scale 0.1".
  87.  
  88. This would have the effect of giving a deadzone of 20% in the center the yaxis of your joystick, 
  89. while scaling the input signal by a factor of 0.1. Pushing forward would increase your HERC's forward throttle 
  90. at a parabolic rate, and pulling back would do the same thing, in reverse.
  91. Obviously, other combinations are possible.
  92.  
  93. 4.  LOADING A CUSTOM KEYMAP FILE
  94. --------------------------------
  95.  
  96. In order to load a custom keymap file, it needs to  be located in the ..\es3Alpha\keymaps directory.
  97. At the Player Setup Menu, click on the Input Configuration field. This will call up a list of the
  98. available KeyMap files.  Highlight the one you want to load. 
  99.  
  100.  
  101. 5.  INPUT
  102. --------------------------------------------------------------------------------------------
  103.  
  104. JOYSTICK INPUT( keyword is "joystick" ):
  105.  
  106. "zaxis"
  107. "yaxis"
  108. "xaxis"
  109. "rzaxis"
  110. "xpov"
  111. "ypov"
  112. "button0"
  113. "button1"
  114. "button2"
  115. "button3" 
  116. "button4"
  117. "button5"
  118. "button6"
  119. "button7"
  120. "button8"
  121. "button9"
  122. "button10"
  123.  
  124. MOUSE INPUT( keyword is "mouse" ):
  125.  
  126. "xaxis"
  127. "yaxis"
  128. "zaxis"
  129. "button0"
  130. "button1"
  131. "button2"
  132. "button3"
  133.  
  134. KEYBOARD INPUT( keyword is "keyboard" ):
  135.  
  136. Note that key modifiers( alt, shift, control) are supported, 
  137. but the modifier must come before the key (e.g., "shift s").
  138. Any key not listed below is represented by it's direct keyboard character.
  139.  
  140. "escape"      Esc
  141. "backspace"    BackSpace
  142. "tab"        Tab
  143. "enter"        Enter
  144. "control"    Control
  145. "shift"        Shift
  146. "alt"        Alt
  147. "capslock"    Caps Lock    
  148. "numlock"    Num Lock
  149. "numpad1"    Numpad1
  150. "numpad2"    Numpad2
  151. "numpad3"    Numpad3
  152. "numpad4"    Numpad4
  153. "numpad5"    Numpad5
  154. "numpad6"    Numpad6
  155. "numpad7"    Numpad7
  156. "numpad8"     Numpad8
  157. "numpad9"    Numpad9
  158. "numpad0"    Numpad0
  159. "numpad+"       Numpad plus
  160. "numpad-"    Numpad minus
  161. "numpad/"    Numpad slash
  162. "numpad*"       Numpad star
  163. "scroll"    Scroll Lock
  164. "numpadequals"    Numpad Equals
  165. "stop"        Stop
  166. "numpadenter"    Numpad Enter
  167. "numpadcomma"    Numpad Comma
  168. "sysreq"    Print Screen/ Sys Req
  169. "home"        Home
  170. "up"        Up Arrow
  171. "down"        Down Arrow
  172. "left"        Left Arrow
  173. "right"        Right Arrow
  174. "end"        End
  175. "next"        Next
  176. "insert"    Insert
  177. "delete"    Delete
  178. "win"        Windows
  179. "app"        Apps
  180.  
  181.  
  182. 6.  ACTION DEFINITIONS
  183. ------------------------------------------------------------------------------
  184.  
  185. ACTIONS                PARAMETER DEFINITIONS    
  186.  
  187. ACTION_NAVPOINT_NEXT        No value needed, Selects to next navpoint
  188. ACTION_NAVPOINT_PREV        No value needed, Selects to previous navpoint
  189. ACTION_NAVPOINT_SET        Value selects navpoint
  190. ACTION_NEXT            No value needed, jumps to next HERC while in OrbitCamera mode
  191. ACTION_PREV            No value needed, jumps to previous HERC while in OrbitCamera mode
  192. ACTION_REVERSE_THROTTLE:    No value needed, toggles reverse throttle
  193. ACTION_LOOK_CENTER:        No value needed, centers pov
  194. ACTION_ZOOM_SET:        Values range from 0.0 to 1.0, sets zoom level
  195. ACTION_ZOOM_ADJUST:        Values range from -1.0 to 1.0, adjusts zoom level based on value
  196. ACTION_SPEED:            1.0 equals max speed, -1.0 equals reverse, 0.0 equals stop
  197. ACTION_ROLL:            1.0 equals max roll left, -1.0 equals max roll right
  198. ACTION_PITCH:            1.0 equals max pitch forward, -1.0 equals max pitch backwards
  199. ACTION_YAW:            1.0 equals max yaw left, -1.0 equals max yaw right             
  200. ACTION_STOP:            No value needed, stops the HERC
  201. ACTION_MOVE_X:            1.0 move the camera to the left, -1.0 moves the camera to the right
  202. ACTION_MOVE_Y:            1.0 moves the camera towards your pov,-1.0 moves it away
  203. ACTION_MOVE_Z:            1.0 moves the camera up, -1.0 moves the camera down
  204. ACTION_WEAPON_ADJ:        1.0 selects next weapon, -1.0 selects previous weapon
  205. ACTION_SELECT_WEAPON:        Values range from 0.0 to 8.0, number indicates which weapon to select
  206. ACTION_REACTOR:            No value needed, turns power off ( crucial for using loading and healing pads ).
  207. ACTION_LOOK_X:            1.0 looks left, -1.0 looks right
  208. ACTION_LOOK_Y:            1.0 looks up, -1.0 looks down
  209. ACTION_FIRE:            1.0 fires, 0.0 stops firing, -1.0 fires ALPHA strike (all weapons)
  210. ACTION_WEAPON_LINK        No values, needed, works as a toggle to link like weapons
  211. ACTION_CAMOUFLAGE:        No value needed, toggles camouflage
  212. ACTION_USE_PROJECTILE_CAM:    No value needed, camera follows your next shot
  213. ACTION_CROUCH:            1.0 crouches, 0.0 stops crouching
  214. ACTION_SHIELD:            No value needed,toggles shields
  215. ACTION_SHIELD_TRACK        No values needed,toggles, toggles shield track
  216. ACTION_SHIELD_FOCUS_SET:    Value ranges from 0.0 to 1.0, value sets focus
  217. ACTION_SHIELD_FOCUS_ADJ :    Value ranges from 0.0 to 1.0, Value is added to current focus of your shield
  218. ACTION_SHIELD_ROTATION_ADJ:    Value range from 0.0 to 1.0, Value is added the current position of your shield 
  219. ACTION_SHIELD_ROTATION_SET:    Value ranges from 0.0 to 1.0, value sets shield position, with 0.0 being front. 
  220. ACTION_TARGET_ADJ:        1.0 targets the next  available target, -1.0 targets the previous available target
  221. ACTION_TARGET_CLOSEST:        No value needed, Targets closest targettable object
  222. ACTION_TARGET_SELECTED:        No value needed, Targets object currently underneath reticle
  223. ACTION_SENSOR_RANGE_TOGGLE:    No value needed, toggles radar
  224. ACTION_SENSOR_RANGE_SET:    Values range from 1.0 to 0.0, sets range of sensors
  225. ACTION_SENSOR_MODE_TOGGLE:    No Values needed, toggles from passive to active
  226.  
  227.  
  228. 7.  EXAMPLES
  229. -----------------------------------------------------------------------------------
  230. These examples are some of the more commonly asked questions about creating a custom keymapping:
  231.  
  232. Q: How do I use my joystick axis to look?
  233.  
  234. A: bindAction joystick xaxis TO ACTION_LOOK_X deadzone 0.1 center square
  235.    bindAction joystick yaxis TO ACTION_LOOK_Y deadzone 0.1 center square
  236.    
  237.  
  238. Q: How do I use the joystick hat to look?
  239.  
  240. A: bindAction joystick xpov TO ACTION_LOOK_X flip
  241.    bindAction joystick ypov TO ACTION_LOOK_Y 
  242.  
  243.  
  244. Q: How do I reconfigure the throttle ?
  245.  
  246. A: It depends on which device you want to use as input.  For keyboard, you might want something like this:
  247.         
  248.     bindAction keyboard make up TO ACTION_SPEED +1.0
  249.     bindAction keyboard break up TO ACTION_SPEED  0.0
  250.  
  251.    For joystick zaxis ( throttle ):
  252.    
  253.     bindAction joystick zaxis TO ACTION_SPEED deadzone 0.1 center square
  254.  
  255.  
  256. Q: When I look with my mouse/ joystick/ keyboard, the HERC response seems backwards.  How do I fix this ?
  257.     
  258. A: Simply add the flip parameter at the end of the appropriate action in your custom keymap file.
  259.    If flip is already there, remove it. This will flip the logical response of your HERC.
  260.  
  261.  
  262. Q: I added a keyboard command, but it dosn't seem to work. What's the deal?
  263.  
  264. A: Make sure you typed 'make' or 'break' before the specific key you wanted to bind.  Otherwise nothing will happen.
  265.    Also, key combinations involving more than two keys will not work.
  266.  
  267.  
  268. Q: Whenever I try to use the joystick hat, my HERC fires or does some other incorrect action.
  269.  
  270. A: Most likely you need to recalibrate your joystick.  To do this, select Start menu/settings/control panel/Game Controllers. 
  271.    and calibrate.